Annotations priority docs #2683
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matthewborden
requested review from
mbelton-buildkite and
gilesgas
as code owners
|
Preview URL: https://2683--bk-docs-preview.netlify.app |
| <tr> | ||
| <th><code>priority</code></th> | ||
| <td> | ||
| An integer value by which to order the annotations on the build. This allows influencing the order of annotations. Ranges from 1 to 10, with 10 being the highest priority and 1 being the lowest. If priority is not set, the default priority is 3. |
There was a problem hiding this comment.
Suggested change
| An integer value by which to order the annotations on the build. This allows influencing the order of annotations. Ranges from 1 to 10, with 10 being the highest priority and 1 being the lowest. If priority is not set, the default priority is 3. | |
| An integer value used to order the annotations on the build, allowing for controlled prioritization. Priority levels ranges from 1 to 10, with 10 being the highest priority and 1 being the lowest. If not specified, annotations default to a priority of 3. |
seeing if I can make the phrasing just a little more concise :)
gilesgas
reviewed
Apr 22, 2024
Comment on lines
+50
to
+54
| buildkite-agent annotate 'Example 1 (Priority 1)' --context 'first' --priority 1 | ||
| buildkite-agent annotate 'Example 2 (Priority 10)' --style 'info' --context 'second' --priority 10 | ||
| buildkite-agent annotate 'Example 3 (Priority 4)' --style 'warning' --context 'third' --priority 4 | ||
| buildkite-agent annotate 'Example 4 (Priority 4)' --style 'error' --context 'fourth' --priority 4 | ||
| buildkite-agent annotate 'Example 5 (Priority 3, Default)' --style 'success' --context 'fifth' |
There was a problem hiding this comment.
Since the code block doesn't hold the entire width of each line, I'd move the --priority X options to the first position, similar to how the --style options are in the first position (in the section above)...
Suggested change
| buildkite-agent annotate 'Example 1 (Priority 1)' --context 'first' --priority 1 | |
| buildkite-agent annotate 'Example 2 (Priority 10)' --style 'info' --context 'second' --priority 10 | |
| buildkite-agent annotate 'Example 3 (Priority 4)' --style 'warning' --context 'third' --priority 4 | |
| buildkite-agent annotate 'Example 4 (Priority 4)' --style 'error' --context 'fourth' --priority 4 | |
| buildkite-agent annotate 'Example 5 (Priority 3, Default)' --style 'success' --context 'fifth' | |
| buildkite-agent annotate 'Example 1 (Priority 1)' --priority 1 --context 'first' | |
| buildkite-agent annotate 'Example 2 (Priority 10)' --priority 10 --style 'info' --context 'second' | |
| buildkite-agent annotate 'Example 3 (Priority 4)' --priority 4 --style 'warning' --context 'third' | |
| buildkite-agent annotate 'Example 4 (Priority 4)' --priority 4 --style 'error' --context 'fourth' | |
| buildkite-agent annotate 'Example 5 (Priority 3, Default)' --style 'success' --context 'fifth' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recently we've introduced the ability to control the ordering of build annotations using priority, a customer provided ordering. Priority is an integer value from
1to10with10being the highest and1being the lowest. Annotations are ordered by priority then by the most recently created at annotation first.This updates the Agent CLI docs with the new
buildkite-agent annotate --priority 10flag, and also updates the REST API docs to include the field when creating and reading annotations for a build.